Skip to content

SOLR-18216 Fix documentation bug for jwt-auth blockUnkonwn#4374

Merged
janhoy merged 6 commits intoapache:branch_9xfrom
janhoy:fix/SOLR-18216-jwt-blockUnknown-default-docs
Apr 29, 2026
Merged

SOLR-18216 Fix documentation bug for jwt-auth blockUnkonwn#4374
janhoy merged 6 commits intoapache:branch_9xfrom
janhoy:fix/SOLR-18216-jwt-blockUnknown-default-docs

Conversation

@janhoy
Copy link
Copy Markdown
Contributor

@janhoy janhoy commented Apr 28, 2026

https://issues.apache.org/jira/browse/SOLR-18216

  • Corrects the documented default for blockUnknown in the JWT Authentication Plugin from true to false (unauthenticated requests are passed through by default).
  • Adds a [WARNING] callout in the plugin reference page alerting users to the previous documentation error.
  • Fixes a callout in the complex config example that incorrectly said "blockUnknown": true "is also the default".
  • Adds a corrective note under the Solr 9.11 section of major-changes-in-solr-9.adoc advising users who relied on the wrong documented default to add "blockUnknown": true explicitly.

@janhoy janhoy requested a review from Copilot April 28, 2026 08:50
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Apr 28, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Fixes reference-guide documentation around the JWT Authentication Plugin’s blockUnknown default, clarifying that it defaults to false (unauthenticated requests pass through unless explicitly blocked), and adds upgrade-note guidance for users who relied on the previously incorrect docs.

Changes:

  • Correct blockUnknown default documentation in the JWT plugin reference page and add a warning callout about the prior documentation error.
  • Add an upgrade-notes entry (Solr 9.11) advising users to explicitly set "blockUnknown": true if they relied on the incorrect documented default.
  • Add an unreleased changelog fragment for SOLR-18216.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File Description
solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-9.adoc Adds a Solr 9.11 upgrade note about the corrected blockUnknown default.
solr/solr-ref-guide/modules/deployment-guide/pages/jwt-authentication-plugin.adoc Corrects blockUnknown default docs, updates callouts, and adds a warning about the prior incorrect default.
changelog/unreleased/SOLR-18216-jwt-blockUnknown-default-docs.yml Adds changelog entry describing the documentation fix.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-9.adoc Outdated
Comment thread changelog/unreleased/SOLR-18216-jwt-blockUnknown-default-docs.yml Outdated
Copy link
Copy Markdown
Contributor

@epugh epugh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks Great to me.

@janhoy janhoy merged commit 85b8568 into apache:branch_9x Apr 29, 2026
5 checks passed
@janhoy janhoy deleted the fix/SOLR-18216-jwt-blockUnknown-default-docs branch April 29, 2026 07:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants